Functions
MvCameraControl_class Namespace Reference

Functions

def get_platform_functype ()
 
def check_sys_and_update_dll ()
 
def MV_CC_Initialize ()
 Initializes SDK resources. More...
 
def MV_CC_Finalize ()
 Releases SDK resources. More...
 
def MV_CC_GetSDKVersion ()
 Gets SDK version. More...
 
def MV_CC_EnumDevices (nTLayerType, stDevList)
 Enumerates devices. More...
 
def MV_CC_EnumDevicesEx (nTLayerType, stDevList, strManufacturerName)
 Enumerates devices based on manufacturer name. More...
 
def MV_CC_EnumDevicesEx2 (nTLayerType, stDevList, strManufacturerName, enSortMethod)
 Enumerates devices, supporting enumerating devices by specified sorting method and filtering by manufacturer name. More...
 
def MV_CC_IsDeviceAccessible (stDevInfo, nAccessMode)
 Checks if the specified device can be accessed. More...
 
def MV_CC_CreateHandle (self, stDevInfo)
 Creates device handle. More...
 
def MV_CC_DestroyHandle (self)
 Destroys the device handle. More...
 
def MV_CC_OpenDevice (self, nAccessMode=MV_ACCESS_Exclusive, nSwitchoverKey=0)
 Turns on the device. More...
 
def MV_CC_CloseDevice (self)
 Turns off the device. More...
 
def MV_CC_IsDeviceConnected (self)
 Checks if the device is connected. More...
 
def MV_CC_RegisterImageCallBackEx (self, CallBackFun, pUser)
 Registers an image data callback. More...
 
def MV_CC_RegisterImageCallBackEx2 (self, CallBackFun, pUser, bAutoFree)
 Registers an image data callback. More...
 
def MV_CC_RegisterStreamExceptionCallBack (self, CallBackFun, pUser)
 Registers a stream exception callback. More...
 
def MV_CC_StartGrabbing (self)
 Starts grabbing images. More...
 
def MV_CC_StopGrabbing (self)
 Stops grabbing images. More...
 
def MV_CC_GetImageBuffer (self, stFrame, nMsec)
 Gets one frame of image using internal buffer. More...
 
def MV_CC_FreeImageBuffer (self, stFrame)
 Releases image buffer. More...
 
def MV_CC_GetPayloadSize (self, pnPayloadSize, pnAlignment)
 Gets the device payload size (including image data and Chunk data) and memory alignment method. More...
 
def MV_CC_GetOneFrameTimeout (self, pData, nDataSize, stFrameInfo, nMsec=1000)
 Gets one frame of image with timeout, and the SDK waits internally to return until data is available. More...
 
def MV_CC_ClearImageBuffer (self)
 Clears the image buffer. More...
 
def MV_CC_GetValidImageNum (self, nValidImageNum)
 Gets the number of valid images in the current image buffer. More...
 
def MV_CC_DisplayOneFrameEx (self, hWnd, pstDisplayInfo)
 Displays one frame of image (extended API 1). More...
 
def MV_CC_DisplayOneFrameEx2 (self, hWnd, pstImage, enRenderMode)
 Displays one frame of image (extended API 2). More...
 
def MV_CC_SetImageNodeNum (self, nNum)
 Sets the number of nodes for SDK internal image buffer. More...
 
def MV_CC_SetGrabStrategy (self, enGrabStrategy)
 Sets the image grabbing strategy. More...
 
def MV_CC_SetOutputQueueSize (self, nOutputQueueSize)
 Sets the number of output buffers, range: [1, ImageNodeNum]. More...
 
def MV_CC_GetDeviceInfo (self, stDevInfo)
 Gets the device information. More...
 
def MV_CC_GetAllMatchInfo (self, stInfo)
 Gets the information of all types. More...
 
def MV_CC_EnumInterfaces (nTLayerType, stInterfaceInfoList)
 Enumerates frame grabbers. More...
 
def MV_CC_CreateInterface (self, stInterfaceInfo)
 Creates frame grabber handle. More...
 
def MV_CC_CreateInterfaceByID (self, InterfaceID)
 Creates frame grabber handle by frame grabber ID. More...
 
def MV_CC_OpenInterface (self)
 Turns on the frame grabber. More...
 
def MV_CC_CloseInterface (self)
 Turns off the frame grabber. More...
 
def MV_CC_DestroyInterface (self)
 Destroys the frame grabber handle. More...
 
def MV_CC_EnumDevicesByInterface (self, stDevList)
 Enumerates devices by frame grabber handle. More...
 
def MV_CC_GetIntValueEx (self, strKey, stIntValue)
 Gets the value of integer type node. More...
 
def MV_CC_SetIntValueEx (self, strKey, nValue)
 Sets the value of integer type node. More...
 
def MV_CC_GetEnumValue (self, strKey, stEnumValue)
 Gets the value of enumeration type node. More...
 
def MV_CC_GetEnumValueEx (self, strKey, stEnumValue)
 Gets the value of enumeration type node (extended). More...
 
def MV_CC_SetEnumValue (self, strKey, nValue)
 Sets the value of enumeration type node. More...
 
def MV_CC_GetEnumEntrySymbolic (self, strKey, stEnumEntry)
 Gets the enumerator name according to the node name and assigned value. More...
 
def MV_CC_SetEnumValueByString (self, strKey, sValue)
 Sets the value of enumeration type node. More...
 
def MV_CC_GetFloatValue (self, strKey, stFloatValue)
 Gets the value of float type node. More...
 
def MV_CC_SetFloatValue (self, strKey, fValue)
 Sets the value of float type node. More...
 
def MV_CC_GetBoolValue (self, strKey, BoolValue)
 Gets the value of boolean type node. More...
 
def MV_CC_SetBoolValue (self, strKey, bValue)
 Sets the value of boolean type node. More...
 
def MV_CC_GetStringValue (self, strKey, StringValue)
 Gets the value of string type node. More...
 
def MV_CC_SetStringValue (self, strKey, sValue)
 Sets the value of string type node. More...
 
def MV_CC_SetCommandValue (self, strKey)
 Sets the value of command type node. More...
 
def MV_CC_ReadMemory (self, pBuffer, nAddress, nLength)
 Reads data from device register. More...
 
def MV_CC_WriteMemory (self, pBuffer, nAddress, nLength)
 Writes data into device register. More...
 
def MV_CC_InvalidateNodes (self)
 Clears the buffer of the GenICam node. More...
 
def MV_XML_GetGenICamXML (self, pData, nDataSize, pnDataLen)
 Gets the XML file of device feature tree. More...
 
def MV_XML_GetNodeAccessMode (self, strName, penAccessMode)
 Gets the access mode of the current node. More...
 
def MV_XML_GetNodeInterfaceType (self, strName, penInterfaceType)
 Gets the type of the current node. More...
 
def MV_CC_FeatureSave (self, strFileName)
 Saves device features. More...
 
def MV_CC_FeatureLoad (self, strFileName)
 Imports device features. More...
 
def MV_CC_FeatureLoadEx (self, strFileName, pstNodeErrorList)
 Imports device features, and saves error information list. More...
 
def MV_CC_FileAccessRead (self, stFileAccess)
 Reads files from the device. More...
 
def MV_CC_FileAccessReadEx (self, pstFileAccessEx)
 Reads the Data file from the device (extended). More...
 
def MV_CC_FileAccessWrite (self, stFileAccess)
 Writes files to the device. More...
 
def MV_CC_FileAccessWriteEx (self, pstFileAccessEx)
 Writes buffer to the device (extended). More...
 
def MV_CC_GetFileAccessProgress (self, pstFileAccessProgress)
 Gets the file access progress. More...
 
def MV_CC_LocalUpgrade (self, strFilePathName)
 Upgrades device via local file. More...
 
def MV_CC_GetUpgradeProcess (self, nProcess)
 Gets the upgrade progress. More...
 
def MV_CC_RegisterExceptionCallBack (self, ExceptionCallBackFun, pUser)
 Registers an exception callback. More...
 
def MV_CC_RegisterAllEventCallBack (self, EventCallBackFun, pUser)
 Registers a callback for all events. More...
 
def MV_CC_RegisterEventCallBackEx (self, pEventName, EventCallBackFun, pUser)
 Registers a callback for single event. More...
 
def MV_CC_EventNotificationOn (self, strEventName)
 Enables specified event of device. More...
 
def MV_CC_EventNotificationOff (self, strEventName)
 Disables specified event of device. More...
 
def MV_GIGE_SetEnumDevTimeout (nMilTimeout)
 Sets enumeration timeout duration, range: [1, UINT_MAX). More...
 
def MV_GIGE_ForceIpEx (self, nIP, nSubNetMask, nDefaultGateWay)
 Sets device network parameters forcefully, including IP address, subnet mask, and default gateway. More...
 
def MV_GIGE_SetIpConfig (self, nType)
 Configures IP mode. More...
 
def MV_GIGE_SetNetTransMode (self, nType)
 Sets SDK internal priority network mode. More...
 
def MV_GIGE_GetNetTransInfo (self, pstInfo)
 Gets network transmission information. More...
 
def MV_GIGE_SetDiscoveryMode (nMode)
 Sets the ACK mode of enumeration command. More...
 
def MV_GIGE_SetGvspTimeout (self, nMillisec)
 Sets the timeout duration for image grabbing via GVSP. More...
 
def MV_GIGE_GetGvspTimeout (self, pnMillisec)
 Gets the timeout duration of image grabbing via GVSP. More...
 
def MV_GIGE_SetGvcpTimeout (self, nMillisec)
 Sets timeout duration for GVCP command. More...
 
def MV_GIGE_GetGvcpTimeout (self, pnMillisec)
 Gets timeout duration for GVCP command. More...
 
def MV_GIGE_SetRetryGvcpTimes (self, nRetryGvcpTimes)
 Sets the number of times for resending GVCP command. More...
 
def MV_GIGE_GetRetryGvcpTimes (self, pnRetryGvcpTimes)
 Gets the number of times for resending GVCP command. More...
 
def MV_CC_GetOptimalPacketSize (self)
 Gets the optimal packet size. More...
 
def MV_GIGE_SetResend (self, bEnable, nMaxResendPercent=100, nResendTimeout=50)
 Sets whether to enable packet resending, and sets corresponding parameters. More...
 
def MV_GIGE_SetResendMaxRetryTimes (self, nRetryTimes)
 Sets the maximum command resending times. More...
 
def MV_GIGE_GetResendMaxRetryTimes (self, nRetryTimes)
 Gets the maximum command resending times. More...
 
def MV_GIGE_SetResendTimeInterval (self, nMillisec)
 Sets the time interval of two resending requests for one packet. More...
 
def MV_GIGE_GetResendTimeInterval (self, nMillisec)
 Gets the time interval of two resending requests for one packet. More...
 
def MV_GIGE_SetTransmissionType (self, stTransmissionType)
 Sets the transmission mode, including unicast and multicast. More...
 
def MV_GIGE_IssueActionCommand (pstActionCmdInfo, pstActionCmdResults)
 Sends action commands. More...
 
def MV_GIGE_GetMulticastStatus (pstDevInfo, pbStatus)
 Gets the multicast status. More...
 
def MV_CAML_GetSerialPortList (stSerialPortList)
 Gets the serial port information list. More...
 
def MV_CAML_SetEnumSerialPorts (stSerialPortList)
 Specifies the serial ports for enumeration. More...
 
def MV_CAML_SetDeviceBaudrate (self, nBaudrate)
 Sets baud rate for the device. More...
 
def MV_CAML_GetDeviceBaudrate (self, pnCurrentBaudrate)
 Gets the baud rate of the device. More...
 
def MV_CAML_GetSupportBaudrates (self, pnBaudrateAblity)
 Gets the supported baud rate of the connection between the device and host. More...
 
def MV_CAML_SetGenCPTimeOut (self, nMillisec)
 Sets the waiting duration for serial port operation. More...
 
def MV_USB_SetTransferSize (self, nTransferSize)
 Sets transmission packet size of USB3 vision devices. More...
 
def MV_USB_GetTransferSize (self, pnTransferSize)
 Gets transmission packet size of USB3 vision cameras. More...
 
def MV_USB_SetTransferWays (self, nTransferWays)
 Sets the number of transmission channels of USB3 vision devices. More...
 
def MV_USB_GetTransferWays (self, pnTransferWays)
 Gets the number of transmission channels of USB3 vision devices. More...
 
def MV_USB_SetEventNodeNum (self, nEventNodeNum)
 Sets the number of event buffer nodes of USB3 vision devices. More...
 
def MV_USB_SetSyncTimeOut (self, nMills)
 Sets the timeout duration for sync reading and writing of USB3 vision devices, range: [1000, UNIT_MAX]. More...
 
def MV_USB_GetSyncTimeOut (self, nMills)
 Gets the timeout duration of sync reading and writing of USB3 vision devices. More...
 
def MV_CC_EnumInterfacesByGenTL (stIFList, strGenTLPath)
 Enumerates interfaces via GenTL. More...
 
def MV_CC_EnumDevicesByGenTL (stIFInfo, stDevList)
 Enumerates devices via GenTL interfaces. More...
 
def MV_CC_UnloadGenTLLibrary (GenTLPath)
 Unloads the CTI library. More...
 
def MV_CC_CreateHandleByGenTL (self, stDevInfo)
 Creates the device handle by GenTL related device information. More...
 
def MV_CC_SaveImageEx3 (self, stSaveParam)
 Saves images, supporting BMP and JPEG. More...
 
def MV_CC_SaveImageToFileEx (self, pstSaveFileParam)
 Saves images to files. More...
 
def MV_CC_SaveImageToFileEx2 (self, pstImage, pSaveImageParam, pcImagePath)
 Saves images to files. More...
 
def MV_CC_RotateImage (self, stRotateParam)
 Rotates images. More...
 
def MV_CC_FlipImage (self, pstFlipParam)
 Flips images. More...
 
def MV_CC_ConvertPixelTypeEx (self, pstCvtParam)
 Converts pixel format. More...
 
def MV_CC_SetBayerCvtQuality (self, nBayerCvtQuality)
 Sets the interpolation method of Bayer format. More...
 
def MV_CC_SetBayerFilterEnable (self, bFilterEnable)
 Enables or disables the smoothing function of interpolation algorithm. More...
 
def MV_CC_SetBayerGammaValue (self, fBayerGammaValue)
 Sets the Gamma value in Bayer pattern. More...
 
def MV_CC_SetGammaValue (self, enSrcPixelType, fGammaValue)
 Sets Gamma value in Mono 8 or Bayer 8/10/12/16 pattern. More...
 
def MV_CC_SetBayerGammaParam (self, stGammaParam)
 Sets Gamma information in Bayer pattern. More...
 
def MV_CC_SetBayerCCMParam (self, stCCMParam)
 Enables/disables CCM and sets CCM parameters in Bayer pattern. More...
 
def MV_CC_SetBayerCCMParamEx (self, stCCMParam)
 Enables/disables CCM and sets CCM parameters in Bayer pattern (extended API). More...
 
def MV_CC_ImageContrast (self, stConstrastParam)
 Adjusts image contrast. More...
 
def MV_CC_PurpleFringing (self, pstPurpleFringingParam)
 Corrects purple fringing of the image. More...
 
def MV_CC_HBDecode (self, stDecodeParam)
 Decodes lossless compression stream into raw data. More...
 
def MV_CC_StartRecord (self, stRecordParam)
 Starts recording. More...
 
def MV_CC_InputOneFrame (self, stInputFrameInfo)
 Inputs raw data for recording. More...
 
def MV_CC_InputOneFrameEx (self, stInputFrameInfo)
 Input RAW data to Record. More...
 
def MV_CC_StopRecord (self)
 Stops recording. More...
 
def MV_CC_ReconstructImage (self, stReconstructParam)
 Reconstructs the image for multi-light control. More...
 
def MV_CC_SerialPort_Open (self)
 Opens the serial port. More...
 
def MV_CC_SerialPort_Write (self, pBuffer, nLength, pnWriteLen)
 Writes data to the serial port, allowing a maximum of 512 bytes written at a time. More...
 
def MV_CC_SerialPort_Read (self, pBuffer, nLength, pnReadLen, nMsec)
 Reads the serial port data. More...
 
def MV_CC_SerialPort_ClearBuffer (self)
 Clears the received serial port data. More...
 
def MV_CC_SerialPort_Close (self)
 Closes the serial port. More...
 
def MV_CC_EnumerateTls ()
 
def MV_CC_SetSDKLogPath (self, SDKLogPath)
 
def MV_CC_GetIntValue (self, strKey, stIntValue)
 
def MV_CC_SetIntValue (self, strKey, nValue)
 
def MV_CC_CreateHandleWithoutLog (self, stDevInfo)
 
def MV_CC_RegisterImageCallBackForRGB (self, CallBackFun, pUser)
 
def MV_CC_RegisterImageCallBackForBGR (self, CallBackFun, pUser)
 
def MV_CC_GetImageForRGB (self, pData, nDataSize, stFrameInfo, nMsec)
 
def MV_CC_GetImageForBGR (self, pData, nDataSize, stFrameInfo, nMsec)
 
def MV_CC_DisplayOneFrame (self, stDisplayInfo)
 
def MV_CC_SaveImageEx2 (self, stSaveParam)
 
def MV_CC_SaveImageToFile (self, stSaveFileParam)
 
def MV_CC_SavePointCloudData (self, stPointDataParam)
 
def MV_CC_ConvertPixelType (self, stConvertParam)
 
def MV_CC_OpenParamsGUI (self)
 
def MV_USB_RegisterStreamExceptionCallBack (self, CallBackFun, pUser)
 

Function Documentation

◆ get_platform_functype()

def MvCameraControl_class.get_platform_functype ( )

◆ check_sys_and_update_dll()

def MvCameraControl_class.check_sys_and_update_dll ( )

◆ MV_CC_EnumerateTls()

def MvCameraControl_class.MV_CC_EnumerateTls ( )
static

◆ MV_CC_SetSDKLogPath()

def MvCameraControl_class.MV_CC_SetSDKLogPath (   self,
  SDKLogPath 
)

◆ MV_CC_GetIntValue()

def MvCameraControl_class.MV_CC_GetIntValue (   self,
  strKey,
  stIntValue 
)

◆ MV_CC_SetIntValue()

def MvCameraControl_class.MV_CC_SetIntValue (   self,
  strKey,
  nValue 
)

◆ MV_CC_CreateHandleWithoutLog()

def MvCameraControl_class.MV_CC_CreateHandleWithoutLog (   self,
  stDevInfo 
)

◆ MV_CC_RegisterImageCallBackForRGB()

def MvCameraControl_class.MV_CC_RegisterImageCallBackForRGB (   self,
  CallBackFun,
  pUser 
)

◆ MV_CC_RegisterImageCallBackForBGR()

def MvCameraControl_class.MV_CC_RegisterImageCallBackForBGR (   self,
  CallBackFun,
  pUser 
)

◆ MV_CC_GetImageForRGB()

def MvCameraControl_class.MV_CC_GetImageForRGB (   self,
  pData,
  nDataSize,
  stFrameInfo,
  nMsec 
)

◆ MV_CC_GetImageForBGR()

def MvCameraControl_class.MV_CC_GetImageForBGR (   self,
  pData,
  nDataSize,
  stFrameInfo,
  nMsec 
)

◆ MV_CC_DisplayOneFrame()

def MvCameraControl_class.MV_CC_DisplayOneFrame (   self,
  stDisplayInfo 
)

◆ MV_CC_SaveImageEx2()

def MvCameraControl_class.MV_CC_SaveImageEx2 (   self,
  stSaveParam 
)

◆ MV_CC_SaveImageToFile()

def MvCameraControl_class.MV_CC_SaveImageToFile (   self,
  stSaveFileParam 
)

◆ MV_CC_SavePointCloudData()

def MvCameraControl_class.MV_CC_SavePointCloudData (   self,
  stPointDataParam 
)

◆ MV_CC_ConvertPixelType()

def MvCameraControl_class.MV_CC_ConvertPixelType (   self,
  stConvertParam 
)

◆ MV_CC_OpenParamsGUI()

def MvCameraControl_class.MV_CC_OpenParamsGUI (   self)

◆ MV_USB_RegisterStreamExceptionCallBack()

def MvCameraControl_class.MV_USB_RegisterStreamExceptionCallBack (   self,
  CallBackFun,
  pUser 
)